Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: Remove PII info for external apps #1180

Merged
merged 6 commits into from
Feb 10, 2025
Merged

chore: Remove PII info for external apps #1180

merged 6 commits into from
Feb 10, 2025

Conversation

ashwin1111
Copy link
Contributor

@ashwin1111 ashwin1111 commented Feb 10, 2025 •
edited by coderabbitai bot
Loading

Description

Please add PR description here, add screenshots if needed

Clickup

https://app.clickup.com

Summary by CodeRabbit

  • Refactor
    • Streamlined user and event tracking for integration features to use more consistent and accurate identifiers.
    • Updated processes for survey triggering and landing page interactions, ensuring reliable data logging without exposing sensitive user details.
    • Clarified return type for the getOrCreateOrg method to enhance readability.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 10, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates the user identification process across several integrated services. In the RefinerService, the payload for triggering surveys has been modified by removing email and name properties and replacing workspace_name with org_id. The TrackingService now streamlines the onOpenLandingPage method, accepting only a user ID and Fyle organization ID, and updating its tracking calls accordingly. Additionally, the IntegrationsComponent has been adjusted to pass the new parameters and clarify its return type for organizational data retrieval.

Changes

File(s) Changed Change Summary
src/app/…/refiner.service.ts and src/app/…/tracking.service.ts Updated methods to modify user identity payloads: in triggerSurvey and onOpenLandingPage, removed email and name, replaced workspace_name with org_id, and shifted to using userId and fyleOrgId.
src/app/…/integrations.component.ts Adjusted the invocation of onOpenLandingPage to pass userId and fyleOrgId instead of email, org id, and org name, and clarified the return type of getOrCreateOrg.
src/app/…/tracking.service.spec.ts Updated test case to reflect changes in onOpenLandingPage method parameters, simplifying the arguments to email and id.

Possibly related PRs

Suggested labels

size/M

Poem

I'm a hopping rabbit with code in my heart,
Changing parameters, making a fresh start.
Emails and names bow out with grace,
User IDs and org IDs take their place.
With each little hop and every light byte,
My code garden blooms under the moonlight! 🐰

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bc3fd85 and 279bc11.

📒 Files selected for processing (1)
  • src/app/core/services/integration/tracking.service.spec.ts (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the size/XS Extra Small PR label Feb 10, 2025
coderabbitai[bot]
coderabbitai bot reviewed Feb 10, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/app/core/services/integration/tracking.service.ts (1)

29-29: Rename identityEmail property to reflect its new purpose.

The property name identityEmail is misleading as it now stores a userId instead of an email.

-  private identityEmail: string | undefined;
+  private identityUserId: string | undefined;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f47a2dc and bc3fd85.

📒 Files selected for processing (3)
  • src/app/core/services/integration/refiner.service.ts (1 hunks)
  • src/app/core/services/integration/tracking.service.ts (1 hunks)
  • src/app/integrations/integrations.component.ts (1 hunks)
🔇 Additional comments (3)
src/app/core/services/integration/tracking.service.ts (1)

76-89: LGTM! Successfully removed PII from tracking.

The changes effectively remove PII (email, organization name) from tracking data, replacing them with non-PII identifiers.

src/app/core/services/integration/refiner.service.ts (1)

23-31: LGTM! Successfully removed PII from Refiner identification.

The changes effectively remove PII by:

  • Using only org_id for identification
  • Removing email and name properties
src/app/integrations/integrations.component.ts (1)

66-66: LGTM! Successfully adapted to PII removal changes.

The component correctly implements the tracking service changes by using non-PII identifiers (user_id and fyle_org_id).

@github-actions GitHub Actions
Copy link

Unit Test Coverage % values
Statements 32.99% ( 4129 / 12515 )
Branches 26.34% ( 1172 / 4449 )
Functions 25.56% ( 892 / 3489 )
Lines 33.17% ( 4063 / 12246 )

@ashwin1111 ashwin1111 added the deploy Triggers deployment of active branch to Staging label Feb 10, 2025
@ashwin1111 ashwin1111 merged commit 11b32b9 into master Feb 10, 2025
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@JustARatherRidiculouslyLongUsername JustARatherRidiculouslyLongUsername JustARatherRidiculouslyLongUsername approved these changes

@ruuushhh ruuushhh ruuushhh approved these changes

Assignees
No one assigned
Labels
deploy Triggers deployment of active branch to Staging size/XS Extra Small PR
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ashwin1111 @JustARatherRidiculouslyLongUsername @ruuushhh